高级特性

您所在的位置:网站首页 golang 高级特性 高级特性

高级特性

2023-09-04 03:09| 来源: 网络整理| 查看: 265

CORS对象CORS配置默认CORSOptions限制Origin来源OPTIONS请求示例1,基本使用示例2,授权跨域Origin示例3,自定义检测授权

允许接口跨域往往是需要结合 路由管理-中间件/拦截器 一起使用,来统一设置某些路由规则下的接口可以跨域访问。同时,针对允许WebSocket的跨域请求访问,也是通过该方式来实现。

相关方法: https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#Response

func (r *Response) CORS(options CORSOptions)func (r *Response) CORSAllowedOrigin(options CORSOptions) boolfunc (r *Response) CORSDefault()func (r *Response) DefaultCORSOptions() CORSOptionsCORS对象

CORS是W3互联网标准组织对HTTP跨域请求的标准,在ghttp模块中,我们可以通过CORSOptions对象来管理对应的跨域请求选项。定义如下:

// See https://www.w3.org/TR/cors/ .// 服务端允许跨域请求选项type CORSOptions struct { AllowDomain []string // Used for allowing requests from custom domains AllowOrigin string // Access-Control-Allow-Origin AllowCredentials string // Access-Control-Allow-Credentials ExposeHeaders string // Access-Control-Expose-Headers MaxAge int // Access-Control-Max-Age AllowMethods string // Access-Control-Allow-Methods AllowHeaders string // Access-Control-Allow-Headers}

具体参数的介绍请查看W3组织 官网手册。

CORS配置默认CORSOptions

当然,为方便跨域设置,在ghttp模块中也提供了默认的跨域请求选项,通过DefaultCORSOptions方法获取。大多数情况下,我们在需要允许跨域请求的接口中(一般情况下使用中间件)可以直接使用CORSDefault()允许该接口跨域访问。

限制Origin来源

大多数时候,我们需要限制请求来源为我们受信任的域名列表,我们可以使用AllowDomain配置,使用方式:

// 允许跨域请求中间件func Middleware(r *ghttp.Request) { corsOptions := r.Response.DefaultCORSOptions() corsOptions.AllowDomain = []string{"goframe.org", "johng.cn"} r.Response.CORS(corsOptions) r.Middleware.Next()}OPTIONS请求

有的客户端,部分浏览器在发送AJAX请求之前会首先发送OPTIONS预请求检测后续请求是否允许发送。GF框架的Server完全遵守W3C关于OPTIONS请求方法的规范约定,因此只要服务端设置好CORS中间件,OPTIONS请求也将会自动支持。

示例1,基本使用

我们来看一个简单的接口示例:

package mainimport ( "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/ghttp")func Order(r *ghttp.Request) { r.Response.Write("GET")}func main() { s := g.Server() s.Group("/api.v1", func(group *ghttp.RouterGroup) { group.GET("/order", Order) }) s.SetPort(8199) s.Run()}

接口地址是 http://localhost/api.v1/order ,当然这个接口是不允许跨域的。我们打开一个不同的域名,例如:百度首页(正好用了jQuery,方便调试),然后按F12打开开发者面板,在console下执行以下AJAX请求:

$.get("http://localhost:8199/api.v1/order", function(result){ console.log(result)});

结果如下:

返回了不允许跨域请求的提示错误,接着我们修改一下服务端接口的测试代码,如下:

package mainimport ( "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/ghttp")func MiddlewareCORS(r *ghttp.Request) { r.Response.CORSDefault() r.Middleware.Next()}func Order(r *ghttp.Request) { r.Response.Write("GET")}func main() { s := g.Server() s.Group("/api.v1", func(group *ghttp.RouterGroup) { group.Middleware(MiddlewareCORS) group.GET("/order", Order) }) s.SetPort(8199) s.Run()}

我们增加了针对于路由/api.v1的前置中间件MiddlewareCORS,该事件将会在所有服务执行之前调用。我们通过调用CORSDefault方法使用默认的跨域设置允许跨域请求。该绑定的事件路由规则使用了模糊匹配规则,表示所有/api.v1开头的接口地址都允许跨域请求。

返回刚才的百度首页,再次执行请求AJAX请求,这次便成功了:

当然我们也可以通过CORSOptions对象以及CORS方法对跨域请求做更多的设置。

示例2,授权跨域Origin

在大多数场景中,我们是需要自定义授权跨域的Origin,那么我们可以将以上的例子改进如下,在该示例中,我们仅允许goframe.org及baidu.com跨域请求访问。

package mainimport ( "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/ghttp")func MiddlewareCORS(r *ghttp.Request) { corsOptions := r.Response.DefaultCORSOptions() corsOptions.AllowDomain = []string{"goframe.org", "baidu.com"} r.Response.CORS(corsOptions) r.Middleware.Next()}func Order(r *ghttp.Request) { r.Response.Write("GET")}func main() { s := g.Server() s.Group("/api.v1", func(group *ghttp.RouterGroup) { group.Middleware(MiddlewareCORS) group.GET("/order", Order) }) s.SetPort(8199) s.Run()}示例3,自定义检测授权

不知大家是否有注意,在以上的示例中有个细节,即使当前接口不允许跨域访问,但是只要接口被调用,接口完整逻辑仍会被执行,在服务端其实也已经走完了一次请求流程。针对于这个问题,我们可以通过自定义授权Origin并在中间件中通过CORSAllowedOrigin方法来做判断,如果当前请求的Origin在服务端是被允许执行的,那么才会执行后续流程,否则便会终止执行。

在以下示例中,仅允许来自goframe.org域名的跨域请求,而来自其他域名的请求将会失败并返回403:

package mainimport ( "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/ghttp")func MiddlewareCORS(r *ghttp.Request) { corsOptions := r.Response.DefaultCORSOptions() corsOptions.AllowDomain = []string{"goframe.org"} if !r.Response.CORSAllowedOrigin(corsOptions) { r.Response.WriteStatus(http.StatusForbidden) return } r.Response.CORS(corsOptions) r.Middleware.Next()}func Order(r *ghttp.Request) { r.Response.Write("GET")}func main() { s := g.Server() s.Group("/api.v1", func(group *ghttp.RouterGroup) { group.Middleware(MiddlewareCORS) group.GET("/order", Order) }) s.SetPort(8199) s.Run()}


【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3